﻿/*!
 * Copyright (c), 上海沃恩信息科技有限公司.
 * All rights reserved.
 * Licensed under BSD (https://www.pittypat.work/bsd.html).
 */

using System;

namespace Pittypat
{
    /// <summary>
    /// 表示参数在一个功能中所起的作用。
    /// </summary>
    [Serializable]
    public enum ParameterRole
    {
        /// <summary>
        /// 普通参数。
        /// </summary>
        Normal = 0,

        /// <summary>
        /// 分页查询的页码。
        /// </summary>
        PageIndex = 1,

        /// <summary>
        /// 分页查询的页面尺寸。
        /// </summary>
        PageSize = 2,

        /// <summary>
        /// 返回符合条件的总行数。
        /// </summary>
        TotalRows = 3,

        /// <summary>
        /// 查询时用于排序的列的名称。
        /// </summary>
        OrderName = 4,

        /// <summary>
        /// 查询时用于排序的方向。
        /// </summary>
        OrderDirection = 5,

        /// <summary>
        /// 当前用户的 Id。参数值会由系统自动设置，不需要客户端传递值。
        /// </summary>
        UserId = 6,

        /// <summary>
        /// 当前用户的用户令牌。因为安全原因，不会向目标参数传递用户令牌值。
        /// </summary>
        UserToken = 7,

        /// <summary>
        /// 返回原始的文件路径。主要用于在 API 层删除对应的物理文件。
        /// </summary>
        OldUrl = 8
    }
}
